LinuxQMISDK  SLQS04.00.27
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Functions
qaGobiApiSwiOmadmsExt.h File Reference

Go to the source code of this file.

Data Structures

struct  _SLQSOMADMSettingsReqParamsExt
 
struct  _SLQSOMADMSessionInfoExt
 

Macros

#define SWIOMAEXT_MAX_UCS2_DATA_LEN   512
 

Typedefs

typedef struct
_SLQSOMADMSettingsReqParamsExt 		SLQSOMADMSettingsReqParamsExt
 
typedef struct
_SLQSOMADMSessionInfoExt 		SLQSOMADMSessionInfoExt
 

Functions

ULONG SLQSOMADMStartSessionExt (ULONG sessionType)
 
ULONG SLQSOMADMCancelSessionExt (ULONG session)
 
ULONG SLQSOMADMSendSelectionExt (ULONG selection)
 
ULONG SLQSOMADMSetSettingsExt (SLQSOMADMSettingsReqParamsExt *pSLQSOMADMSettingsReqParams)
 
ULONG SLQSOMADMGetSessionInfoExt (SLQSOMADMSessionInfoExt *pResp)
 

Macro Definition Documentation

#define SWIOMAEXT_MAX_UCS2_DATA_LEN   512

Typedef Documentation

typedef struct _SLQSOMADMSessionInfoExt SLQSOMADMSessionInfoExt

Structure containing the OMA DM Session Info returned by the device. Also used as input parameter to specify the size of variable parameters. (ref. notes)

Parameters
status
  • 1 Byte parameter indicating status of OMADM initialization 0 - OMA module initiation not completed. 1 - OMA module initiation completed but no UI is registered. 128 - OMA initiation completed. 255 - OMA initiation error.
sessionState
  • 1 byte parameter indicating OMA session state 0 - OMA module in CIDC session. 1 - OMA module in CIFUMO session 2 - OMA module in device initiated FUMO session 3 - OMA module in FUMO resume session 4 - OMA module is sending FUMO report 5 - OMA module in device initiated DM session 6 - OMA module in HFA DC session 7 - OMA module in CI PRL session 8 - OMA module in device initiated PRL session 9 - OMA module in HFA PRL session 10 - OMA module in HFA FUMO session 11 - OMA module in NI PRL session 12 - OMA is storing configuration after DC/PRL session 13 - OMA module is blocked by UI 14 - there is a pending session 15 - OMA module in idle state
hfaStatus
  • 1 byte parameter indicating session state 0 - HFA completed 1 - HFA not start 2 - HFA DC completed, but PRL is not completed 3 - HFA PRL completed, but FUMO is not completed
hfaMaxRetry
  • 2 byte parameter indicating max retry for HFA 0 - HFA completed
hfaRetryInterval
  • 2 byte parameter indicating retry interval in seconds for HFA 0 - HFA completed
hfaRetryIndex
  • 2 byte parameter indicating number of retry currently ongoing 0 - no retrying 0xFFFF- Invalid value
fumoState
  • 1 byte parameter indicating fumo state 0 - FUMO state READY 1 - FUMO state DISCOVERY 2 - FUMO state DISCOCONF 3 - FUMO state DOWNLOAD 4 - FUMO state RECEIVED 5 - FUMO state CONFIRM 6 - FUMO state CONFIRMED 7 - FUMO state UPDATE 8 - FUMO state UPDATING 9 - FUMO state UNUSABLE 10 - FUMO state REJECTED 11 - FUMO state REJECTCONF 12 - FUMO state FAILED 13 - FUMO state DENIED 14 - FUMO state UPDATED 15 - FUMO state FINCONF 16 - FUMO state FINISHED
fumoResultCode
  • 4 byte parameter indicating FUMO update image installation result. 200 - Request succeeded 250 - the start of vendor specified success result code 299 - the end of vendor specified success result code 400 - Management client error 401 - User rejected operation 402 - Corrupted update package 403 - Wrong package for device 404 - Invalid package signature 405 - Update package not acceptable 406 - DL auth failure 407 - DL download timeout 408 - Unsupported operation 409 - Err not defined by other code 410 - Firmware update failed 411 - Malformed or bad DL URL 412 - DL server unavailable 450 - vendor specified client error start 499 - vendor specified client error end 500 - DL server error 501 - DL fails due to out of memory 502 - Update fails, out of memory 503 - DL fails due to net issues 550 - vendor defined DL server error start 599 - vendor defined DL server error end 0xFFFFFFFF - invalid value.
pkgVendorNameLength
  • 2 byte parameter indicating Length of package vendor String in WORDs
pkgVendorName
  • Variable length parameter indicating Package Name in UCS2
  • size in bytes is 2*pkgVendorNameLength
pkgSize
  • 4 byte parameter indicating pkg size
pkgVersionNameLength
  • 2 byte parameter indicating Length of Package version Name String in WORDs
pkgVersionName
  • Variable length parameter indicating Package version Name in UCS2
  • size in bytes is 2*pkgVersionNameLength
pkgNameLength
  • 2 byte parameter indicating Length of Package Name String in WORDs
pkgName
  • Variable length parameter indicating Package Name in UCS2
  • size in bytes is 2*pkgNameLength
pkgDescLength
  • 2 byte parameter indicating Length of Package description String in WORDs
pkgDesc
  • Variable length parameter indicating Package description in UCS2
  • size in bytes is 2*pkgDescLength
pkgDateLength
  • 2 byte parameter indicating Length of Package date String in WORDs
pkgDate
  • Variable length parameter indicating Package date in UCS2
  • size in bytes is 2*pkgDateLength
pkgInstallTimeLength
  • 2 byte parameter indicating Length of Package install time String in WORDs
pkgInstallTime
  • Variable length parameter indicating Package install time in UCS2
  • size in bytes is 2*pkgInstallTimeLength
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
As input parameter the members pSourceLength, pPkgNameLength pPkgDescLength, pDateLength, pTimeLength have to be specified. These should contain the initialized size of pSource, pPkgName, pPkgDescription, pDate, pTime respectively.
typedef struct _SLQSOMADMSettingsReqParamsExt SLQSOMADMSettingsReqParamsExt

Structure containing the OMA DM settings to be set on the device

Parameters
FOTAdownload
  • 1 Byte parameter indicating support for FOTA Automatic download
    • 0x00 - Firmware autodownload FALSE
    • 0x01 - Firmware autodownload TRUE
FOTAUpdate
  • 1 byte parameter indicating FOTA Automatic update
    • 0x00 - Firmware autoupdate FALSE
    • 0x01 - Firmware autoupdate TRUE
OMADMEnable[IN]
  • 1 byte parameter indicating OMA DM
    • 0x00 - OMA DM Disabled
    • 0x01 - OMA DM Enabled
OMADMLogEnable[IN]
  • 1 byte parameter indicating OMA DM Logs
    • 0x00 - OMA DM Logs Disabled
    • 0x01 - OMA DM Logs Enabled
FUMOEnable[IN]
  • 1 byte parameter indicating FUMO enabled
    • 0x00 - FUMO Disabled
    • 0x01 - FUMO enabled
PRLEnable[IN]
  • 1 byte parameter indicating PRL Enabled
    • 0x00 - PRL Disabled
    • 0x01 - PRL Enabled
    • 0x02 - Launch a CI PRL
    • 0x03 - PRL Enabled and PRL automatic update every 45 days
    • 0x04 - PRL Enabled and PRL update ever 90 days
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values

Function Documentation

ULONG SLQSOMADMCancelSessionExt ( ULONG  session)

Cancels an ongoing OMA-DM session.

Parameters
session[IN]
  • Session 0: Client Initiated Device Configuration (CIDC) 1: Client initiated FUMO 2: Device initiated FUMO 3: Device Initiated DM
  1. Client Initiated PRL
  2. User Initiated HFA
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
ULONG SLQSOMADMGetSessionInfoExt ( SLQSOMADMSessionInfoExt *  pResp)

Returns information related to the current (or previous if no session is active) OMA-DM session.

Parameters
pResp[IN/OUT]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMSendSelectionExt ( ULONG  selection)

Sends the specified OMA-DM selection for the current network initiated session.

Parameters
selection[IN]
  • OMA-DM NIA Selection 0 - User selects NO 1 - User selects “YES/OK” 2 - User selects “Delay” 3 - User selects “Delay one hour” 4 - User selects “Delay four hours” 5 - User selects “Delay until 2:00 AM”
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
ULONG SLQSOMADMSetSettingsExt ( SLQSOMADMSettingsReqParamsExt *  pSLQSOMADMSettingsReqParams)

Sets the settings related to OMADM. These settings are saved on the modem across power cycles.

Parameters
pSLQSOMADMSettingsReqParams[IN]
Note
Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
ULONG SLQSOMADMStartSessionExt ( ULONG  sessionType)

Starts an OMA-DM session.

Parameters
sessionType[IN]
  • Session type 0: Client Initiated Device Configuration (CIDC) 1: Client initiated FUMO 2: Device initiated FUMO 3: Device Initiated DM
  1. Client Initiated PRL
  2. User Initiated HFA
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved